Draft

[GET] /api/v2/common/drafts/publish-requests

根据指定的文档类型和发布请求类型检索发布请求列表。

参数:

名称	类型	位置	描述
types	string	query	用于过滤发布请求的文档类型逗号分隔列表。如果为空，则默认为预定义类型。示例：“dbd,rdl”
prType	string	query	要过滤的发布请求类型。例如：“紧急”

返回值

状态码: 200

成功

GetPublishRequestsInfoResponseModel

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/drafts/{draftId}

通过 ID 检索特定草稿文档的详细信息。

参数:

名称	类型	位置	描述
draftId必填项	string	path	要检索的草稿文档的唯一标识符。示例：e3808c7e-c0e7-44da-96a2-200b3bb216c6
extendQuery	ExtendQuery	query	查询响应的详细程度。例如：参考、修订
includeIndirectReference	Boolean	query	指示是否在响应中包含间接引用。示例：true

返回值

状态码: 200

成功

DraftVO

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[DELETE] /api/v2/common/drafts/{draftId}

删除文档草稿

参数:

名称	类型	位置	描述
draftId必填项	string	path	草稿 ID

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/common/drafts

根据指定的类型检索草稿文档列表。

参数:

名称	类型	位置	描述
types	string	query	用于过滤草稿的文档类型列表（以逗号分隔）。如果为空，则默认为预定义类型。示例：“article,report”

返回值

状态码: 200

成功

GetDraftsInfoResponseModel

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/drafts/publish-requests/{publishRequestId}

通过 ID 检索有关特定发布请求的详细信息。

参数:

名称	类型	位置	描述
publishRequestId必填项	string	path	要检索的发布请求的唯一标识符。示例：e3808c7e-c0e7-44da-96a2-200b3bb216c6

返回值

状态码: 200

成功

PublishRequestVO

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

类型定义

Ƭ GetPublishRequestsInfoResponseModel

表示 GetPublishRequestsInfo 操作的响应模型，包含发布请求信息的集合。

名称	类型	描述	示例
publishRequestsInfo可为空	PublishRequestVO	Grapecity.Enterprise.Server.V2.Models.PublishRequestVO 对象的可枚举集合，代表每个发布请求的详细信息。

Ƭ PublishRequestVO

表示发布文档的请求，包括有关文档、其批准状态和相关元数据的详细信息。

名称	类型	描述
id可为空	string	发布请求的唯一标识符。
title可为空	string	与发布请求相关的文档的标题。
displayName可为空	string	与发布请求相关的文档的显示名称。
draftId可为空	string	与发布请求相关的文档的草稿标识符。
status	int32	发布请求的状态，以整数表示。
docType可为空	string	与发布请求相关的文档类型。
commit可为空	string	与要发布的文档版本相关的提交标识符。
modifiedBy	SampleUserResponseModel
approvedBy	SampleUserResponseModel
createdBy	SampleUserResponseModel
modified可为空	ISO DateTime Sting	上次修改发布请求的日期和时间。
approved可为空	ISO DateTime Sting	发布请求被批准的日期和时间。
created可为空	ISO DateTime Sting	创建发布请求的日期和时间。
effectiveOps可为空	string	与发布请求相关的有效操作。
draft	DraftVO
documentId可为空	string	与发布请求相关的文档标识符。

Ƭ SampleUserResponseModel

表示用户的简化模型，提供各种响应模型中使用的基本信息。

名称	类型	描述	示例
id可为空	string	用户的唯一标识符。
name可为空	string	用户的名称。

Ƭ DraftVO

表示草稿文档的视图模型，封装与草稿相关的所有相关信息和元数据。

名称	类型	描述
id可为空	string	草稿的唯一标识符。
type可为空	string	草稿的类型。
title可为空	string	草稿的标题。
displayName可为空	string	草稿的显示名称。
description可为空	string	对草案的简要描述。
ext可为空	string	草稿文档的文件扩展名。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	创建草稿的日期和时间。
isDraft	Boolean	指示文档是否为草稿。
isApproval	Boolean	指示草案是否需要批准。
contentType可为空	string	草稿的内容类型。
contentUrl可为空	string	访问草稿内容的 URL。
revisionNo	int32	草案的修订编号。
revisionContentUrl可为空	string	访问草稿具体修订内容的URL。
isSystemReserved	Boolean	表示该草稿是否被系统保留。
hideOnMobile	Boolean	指示是否应在移动设备上隐藏草稿。
meta可为空	string	与草稿相关的元数据。
hideInDocumentPortal	Boolean	指示草稿是否应在文档门户中隐藏。
isResource	Boolean	指示该文档是否被视为资源。
organizationId可为空	string	与草案相关的组织的标识符。
organizationIdPath可为空	string	与草稿相关的组织标识符的路径。
thumbnail可为空	string	草稿缩略图的 URL。
modified可为空	ISO DateTime Sting	草稿最后修改的日期和时间。
modifiedBy	SampleUserResponseModel
customPermissions可为空	`Array<string>`	与草稿相关的自定义权限列表。
effectiveOps可为空	string	可以对草稿执行的有效操作。
security	SecurityResponseModel
references可为空	ReferenceResponseModel	与草案相关的参考文献列表。
revisions可为空	RevisionResponseModel	草案的修订清单。

Ƭ SecurityResponseModel

文档的安全设置。

名称	类型	描述	示例
ownerId可为空	string	所有者的唯一标识符。
permissions可为空	AclEntryQueryModel	文档访问权限。

Ƭ ReferenceResponseModel

表示文档引用的模型，包括有关文档及其权限的详细信息。

名称	类型	描述
documentId可为空	string	引用文档的唯一标识符。
resourceName可为空	string	与该文档关联的资源的名称。
resourceDocType可为空	string	资源文档的类型。
resourceDocName可为空	string	资源文档的名称。
displayName可为空	string	供参考的显示名称。
meta可为空	string	与文档相关的元数据。
documentRev可为空	string	文件的修订。
isDirectChild	Boolean	指示该文档是否是父文档的直接子文档。
permission可为空	string	文档的权限级别。
contentUrl可为空	string	访问文档内容的 URL。
minimalPermission可为空	string	访问文档所需的最低权限。

Ƭ RevisionResponseModel

表示文档修订的模型，包括修订号、注释、元数据和相关用户信息等详细信息。

名称	类型	描述
no	int32	修订号。这通常是一个整数，随着每个新修订而递增。
comment可为空	string	描述本次修订所做更改的评论。
meta可为空	string	与修订相关的元数据，可能包括标签或关键字等详细信息。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	此修订的创建日期和时间。
modifiedBy	SampleUserResponseModel
modified可为空	ISO DateTime Sting	上次修改此修订的日期和时间。
contentUrl可为空	string	访问此修订内容的 URL。
references可为空	ReferenceResponseModel	与此次修订相关的参考列表，例如相关文档或资源。

Ƭ AclEntryQueryModel

为子角色定义 ACL 条目权限。

名称	类型	描述
sub	RoleResponseModel
ops可为空	`Array<string>`	授權操作。
opflags	int32	用于额外控制的操作标志。

Ƭ RoleResponseModel

代表系统内的角色。

名称	类型	描述
id可为空	string	角色的唯一标识符。
name可为空	string	角色的名称。
type可为空	string	角色的类型。

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ ExtendQuery

Enum:

None
EffectiveOps
Security
References
Revisions
Tags
All

定义使用附加信息扩展文档查询的选项。

此枚举允许指定应在文档查询响应中包含哪些附加数据。
它支持按位运算来组合多个选项。

* None - 0 - 不包含任何附加数据。
* EffectiveOps - 1 - 包含适用于文档的有效操作。
* Security - 2 - 包含安全信息，如访问控制列表。
* References - 4 - 包含对其他文档的引用。
* Revisions - 8 - 包含有关文档修订的信息。
* Tags - 16 - 包含与文档关联的标签。
* All - 31 - 包含所有可用的扩展信息。

Ƭ GetDraftsInfoResponseModel

表示 GetDraftsInfo 操作的响应模型，包含草稿文档的集合。

名称	类型	描述	示例
drafts可为空	DraftVO	代表草稿文档的 Grapecity.Enterprise.Server.V2.Models.DraftVO 对象的可枚举集合。